/*
 * Copyright (C) 2007-2012 by XDEV Software, All Rights Reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License version 3.0 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
 
package xdev.ui.event;


import java.awt.Component;
import java.awt.Container;
import java.awt.event.ContainerEvent;
import java.awt.event.ContainerListener;


/**
 * Extended {@link ContainerListener} which observes the complete hierarchy of a
 * {@link Container}.
 * 
 * @author XDEV Software
 * 
 * @since 3.1
 */
public abstract class ContainerHierarchyListener implements ContainerListener
{
	/**
	 * {@inheritDoc}
	 * 
	 * @see #componentAddedInHierarchy(ContainerEvent)
	 */
	@Override
	public final void componentAdded(ContainerEvent e)
	{
		Component child = e.getChild();
		if(child instanceof Container)
		{
			((Container)child).addContainerListener(this);
		}
		
		componentAddedInHierarchy(e);
	}
	

	/**
	 * {@inheritDoc}
	 * 
	 * @see #componentRemovedInHierarchy(ContainerEvent)
	 */
	@Override
	public final void componentRemoved(ContainerEvent e)
	{
		Component child = e.getChild();
		if(child instanceof Container)
		{
			((Container)child).removeContainerListener(this);
		}
		
		componentRemovedInHierarchy(e);
	}
	

	/**
	 * Invoked when a component has been added to any container in the
	 * hierarchy.
	 */
	public abstract void componentAddedInHierarchy(ContainerEvent e);
	

	/**
	 * Invoked when a component has been removed from any container in the
	 * hierarchy.
	 */
	public abstract void componentRemovedInHierarchy(ContainerEvent e);
}
